
<!DOCTYPE HTML>
<html lang="zh-hans" >
    <head>
        <meta charset="UTF-8">
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <title>使用示例 · GitCode Issue Feedback 演示</title>
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <meta name="description" content="">
        <meta name="generator" content="GitBook 3.2.3">
        <meta name="author" content="nutpi">
        
        
    
    <link rel="stylesheet" href="gitbook/style.css">

    
            
                
                <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
                
            
                
                <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
                
            
                
                <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
                
            
        

    

    
        
        <link rel="stylesheet" href="styles/website.css">
        
    

        
    
    
    <meta name="HandheldFriendly" content="true"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black">
    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
    <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">

    
    <link rel="next" href="faq.html" />
    
    
    <link rel="prev" href="configuration.html" />
    

    </head>
    <body>
        
<div class="book">
    <div class="book-summary">
        
            
<div id="book-search-input" role="search">
    <input type="text" placeholder="输入并搜索" />
</div>

            
                <nav role="navigation">
                


<ul class="summary">
    
    

    

    
        
        
    
        <li class="chapter " data-level="1.1" data-path="./">
            
                <a href="./">
            
                    
                    介绍
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.2" data-path="features.html">
            
                <a href="features.html">
            
                    
                    功能特性
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.3" data-path="configuration.html">
            
                <a href="configuration.html">
            
                    
                    配置选项
            
                </a>
            

            
        </li>
    
        <li class="chapter active" data-level="1.4" data-path="examples.html">
            
                <a href="examples.html">
            
                    
                    使用示例
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.5" data-path="faq.html">
            
                <a href="faq.html">
            
                    
                    常见问题
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.6" data-path="changelog.html">
            
                <a href="changelog.html">
            
                    
                    更新日志
            
                </a>
            

            
        </li>
    

    

    <li class="divider"></li>

    <li>
        <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
            本书使用 GitBook 发布
        </a>
    </li>
</ul>


                </nav>
            
        
    </div>

    <div class="book-body">
        
            <div class="body-inner">
                
                    

<div class="book-header" role="navigation">
    

    <!-- Title -->
    <h1>
        <i class="fa fa-circle-o-notch fa-spin"></i>
        <a href="." >使用示例</a>
    </h1>
</div>




                    <div class="page-wrapper" tabindex="-1" role="main">
                        <div class="page-inner">
                            
<div id="book-search-results">
    <div class="search-noresults">
    
                                <section class="normal markdown-section">
                                
                                <h1 id="&#x4F7F;&#x7528;&#x793A;&#x4F8B;">&#x4F7F;&#x7528;&#x793A;&#x4F8B;</h1>
<h2 id="&#x57FA;&#x672C;&#x4F7F;&#x7528;">&#x57FA;&#x672C;&#x4F7F;&#x7528;</h2>
<h3 id="1-&#x5B89;&#x88C5;&#x63D2;&#x4EF6;">1. &#x5B89;&#x88C5;&#x63D2;&#x4EF6;</h3>
<pre><code class="lang-bash">npm install gitbook-plugin-gitcode-issue-feedback
</code></pre>
<h3 id="2-&#x914D;&#x7F6E;-bookjson">2. &#x914D;&#x7F6E; book.json</h3>
<pre><code class="lang-json">{
    <span class="hljs-string">&quot;gitbook&quot;</span>: <span class="hljs-string">&quot;&gt;=3.0.0&quot;</span>,
    <span class="hljs-string">&quot;title&quot;</span>: <span class="hljs-string">&quot;&#x6211;&#x7684;&#x6587;&#x6863;&quot;</span>,
    <span class="hljs-string">&quot;plugins&quot;</span>: [
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>
    ],
    <span class="hljs-string">&quot;pluginsConfig&quot;</span>: {
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>: {
            <span class="hljs-string">&quot;repo&quot;</span>: <span class="hljs-string">&quot;my-org/my-docs&quot;</span>
        }
    }
}
</code></pre>
<h3 id="3-&#x542F;&#x52A8;-gitbook">3. &#x542F;&#x52A8; GitBook</h3>
<pre><code class="lang-bash">gitbook serve
</code></pre>
<h2 id="&#x4E0D;&#x540C;&#x573A;&#x666F;&#x7684;&#x914D;&#x7F6E;">&#x4E0D;&#x540C;&#x573A;&#x666F;&#x7684;&#x914D;&#x7F6E;</h2>
<h3 id="&#x5F00;&#x6E90;&#x9879;&#x76EE;&#x6587;&#x6863;">&#x5F00;&#x6E90;&#x9879;&#x76EE;&#x6587;&#x6863;</h3>
<pre><code class="lang-json">{
    <span class="hljs-string">&quot;pluginsConfig&quot;</span>: {
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>: {
            <span class="hljs-string">&quot;repo&quot;</span>: <span class="hljs-string">&quot;my-org/open-source-project&quot;</span>,
            <span class="hljs-string">&quot;label&quot;</span>: <span class="hljs-string">&quot;&#x62A5;&#x544A;&#x95EE;&#x9898;&quot;</span>
        }
    }
}
</code></pre>
<h3 id="&#x5185;&#x90E8;&#x6587;&#x6863;">&#x5185;&#x90E8;&#x6587;&#x6863;</h3>
<pre><code class="lang-json">{
    <span class="hljs-string">&quot;pluginsConfig&quot;</span>: {
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>: {
            <span class="hljs-string">&quot;repo&quot;</span>: <span class="hljs-string">&quot;my-org/internal-docs&quot;</span>,
            <span class="hljs-string">&quot;label&quot;</span>: <span class="hljs-string">&quot;&#x5185;&#x90E8;&#x53CD;&#x9988;&quot;</span>,
            <span class="hljs-string">&quot;private&quot;</span>: <span class="hljs-literal">true</span>
        }
    }
}
</code></pre>
<h3 id="&#x591A;&#x8BED;&#x8A00;&#x6587;&#x6863;">&#x591A;&#x8BED;&#x8A00;&#x6587;&#x6863;</h3>
<pre><code class="lang-json">{
    <span class="hljs-string">&quot;pluginsConfig&quot;</span>: {
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>: {
            <span class="hljs-string">&quot;repo&quot;</span>: <span class="hljs-string">&quot;my-org/multilingual-docs&quot;</span>,
            <span class="hljs-string">&quot;label&quot;</span>: <span class="hljs-string">&quot;Report Issue&quot;</span>
        }
    }
}
</code></pre>
<h2 id="&#x5B9E;&#x9645;&#x4F7F;&#x7528;&#x6548;&#x679C;">&#x5B9E;&#x9645;&#x4F7F;&#x7528;&#x6548;&#x679C;</h2>
<h3 id="&#x7528;&#x6237;&#x64CD;&#x4F5C;&#x6D41;&#x7A0B;">&#x7528;&#x6237;&#x64CD;&#x4F5C;&#x6D41;&#x7A0B;</h3>
<ol>
<li><strong>&#x9605;&#x8BFB;&#x6587;&#x6863;</strong>: &#x7528;&#x6237;&#x5728;&#x6D4F;&#x89C8;&#x6587;&#x6863;&#x5185;&#x5BB9;</li>
<li><strong>&#x9009;&#x4E2D;&#x6587;&#x672C;</strong>: &#x7528;&#x6237;&#x9009;&#x4E2D;&#x6709;&#x95EE;&#x9898;&#x7684;&#x6587;&#x672C;&#x5185;&#x5BB9;</li>
<li><strong>&#x70B9;&#x51FB;&#x6309;&#x94AE;</strong>: &#x70B9;&#x51FB;&#x53F3;&#x4E0B;&#x89D2;&#x7684;&#x53CD;&#x9988;&#x6309;&#x94AE;</li>
<li><strong>&#x81EA;&#x52A8;&#x8DF3;&#x8F6C;</strong>: &#x81EA;&#x52A8;&#x8DF3;&#x8F6C;&#x5230; GitCode &#x65B0;&#x5EFA;&#x95EE;&#x9898;&#x9875;&#x9762;</li>
<li><strong>&#x586B;&#x5199;&#x95EE;&#x9898;</strong>: &#x95EE;&#x9898;&#x6807;&#x9898;&#x548C;&#x5185;&#x5BB9;&#x5DF2;&#x81EA;&#x52A8;&#x586B;&#x5145;</li>
</ol>
<h3 id="&#x751F;&#x6210;&#x7684;&#x95EE;&#x9898;&#x5185;&#x5BB9;">&#x751F;&#x6210;&#x7684;&#x95EE;&#x9898;&#x5185;&#x5BB9;</h3>
<p>&#x5F53;&#x7528;&#x6237;&#x70B9;&#x51FB;&#x53CD;&#x9988;&#x6309;&#x94AE;&#x65F6;&#xFF0C;&#x4F1A;&#x81EA;&#x52A8;&#x751F;&#x6210;&#x5982;&#x4E0B;&#x683C;&#x5F0F;&#x7684;&#x95EE;&#x9898;&#xFF1A;</p>
<pre><code class="lang-markdown">URL: https://gitcode.com/my-org/my-docs/blob/master/docs/example.md

<span class="hljs-quote">&gt; &#x8FD9;&#x91CC;&#x662F;&#x7528;&#x6237;&#x9009;&#x4E2D;&#x7684;&#x6587;&#x672C;&#x5185;&#x5BB9;</span>
<span class="hljs-quote">&gt; [:memo:](https://gitcode.com/my-org/my-docs/edit/master/docs/example.md#L10 &quot;Edit&quot;) &lt;https://gitcode.com/my-org/my-docs/blob/master/docs/example.md#L10&gt;</span>
</code></pre>
<h2 id="&#x81EA;&#x5B9A;&#x4E49;&#x6837;&#x5F0F;&#x793A;&#x4F8B;">&#x81EA;&#x5B9A;&#x4E49;&#x6837;&#x5F0F;&#x793A;&#x4F8B;</h2>
<h3 id="&#x4E3B;&#x9898;&#x8272;&#x6309;&#x94AE;">&#x4E3B;&#x9898;&#x8272;&#x6309;&#x94AE;</h3>
<pre><code class="lang-css"><span class="hljs-selector-class">.gitbook-plugin-gitcode-issue-feedback</span> {
    <span class="hljs-attribute">background</span>: <span class="hljs-built_in">linear-gradient</span>(135deg, #ff6b6b 0%, #ee5a24 100%);
    <span class="hljs-attribute">border-radius</span>: <span class="hljs-number">30px</span>;
    <span class="hljs-attribute">font-weight</span>: bold;
}
</code></pre>
<h3 id="&#x7B80;&#x6D01;&#x98CE;&#x683C;">&#x7B80;&#x6D01;&#x98CE;&#x683C;</h3>
<pre><code class="lang-css"><span class="hljs-selector-class">.gitbook-plugin-gitcode-issue-feedback</span> {
    <span class="hljs-attribute">background</span>: <span class="hljs-number">#007bff</span>;
    <span class="hljs-attribute">border-radius</span>: <span class="hljs-number">4px</span>;
    <span class="hljs-attribute">box-shadow</span>: none;
    <span class="hljs-attribute">font-size</span>: <span class="hljs-number">12px</span>;
    <span class="hljs-attribute">padding</span>: <span class="hljs-number">8px</span> <span class="hljs-number">16px</span>;
}
</code></pre>
<h3 id="&#x5706;&#x5F62;&#x6309;&#x94AE;">&#x5706;&#x5F62;&#x6309;&#x94AE;</h3>
<pre><code class="lang-css"><span class="hljs-selector-class">.gitbook-plugin-gitcode-issue-feedback</span> {
    <span class="hljs-attribute">background</span>: <span class="hljs-number">#28a745</span>;
    <span class="hljs-attribute">border-radius</span>: <span class="hljs-number">50%</span>;
    <span class="hljs-attribute">width</span>: <span class="hljs-number">50px</span>;
    <span class="hljs-attribute">height</span>: <span class="hljs-number">50px</span>;
    <span class="hljs-attribute">padding</span>: <span class="hljs-number">0</span>;
    <span class="hljs-attribute">display</span>: flex;
    <span class="hljs-attribute">align-items</span>: center;
    <span class="hljs-attribute">justify-content</span>: center;
}
</code></pre>
<h2 id="&#x96C6;&#x6210;&#x5230;&#x73B0;&#x6709;&#x9879;&#x76EE;">&#x96C6;&#x6210;&#x5230;&#x73B0;&#x6709;&#x9879;&#x76EE;</h2>
<h3 id="&#x4E0E;-gitbook-&#x4E3B;&#x9898;&#x96C6;&#x6210;">&#x4E0E; GitBook &#x4E3B;&#x9898;&#x96C6;&#x6210;</h3>
<pre><code class="lang-json">{
    <span class="hljs-string">&quot;plugins&quot;</span>: [
        <span class="hljs-string">&quot;theme-default&quot;</span>,
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>,
        <span class="hljs-string">&quot;search-pro&quot;</span>,
        <span class="hljs-string">&quot;back-to-top-button&quot;</span>
    ],
    <span class="hljs-string">&quot;pluginsConfig&quot;</span>: {
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>: {
            <span class="hljs-string">&quot;repo&quot;</span>: <span class="hljs-string">&quot;my-org/my-docs&quot;</span>
        }
    }
}
</code></pre>
<h3 id="&#x4E0E;-cicd-&#x96C6;&#x6210;">&#x4E0E; CI/CD &#x96C6;&#x6210;</h3>
<p>&#x5728; GitHub Actions &#x4E2D;&#x81EA;&#x52A8;&#x6784;&#x5EFA;&#x6587;&#x6863;&#xFF1A;</p>
<pre><code class="lang-yaml"><span class="hljs-attr">name:</span> Build Documentation
<span class="hljs-attr">on:</span>
<span class="hljs-attr">  push:</span>
<span class="hljs-attr">    branches:</span> [ main ]
<span class="hljs-attr">jobs:</span>
<span class="hljs-attr">  build:</span>
<span class="hljs-attr">    runs-on:</span> ubuntu-latest
<span class="hljs-attr">    steps:</span>
<span class="hljs-attr">      - uses:</span> actions/checkout@v2
<span class="hljs-attr">      - name:</span> Setup Node.js
<span class="hljs-attr">        uses:</span> actions/setup-node@v2
<span class="hljs-attr">        with:</span>
<span class="hljs-attr">          node-version:</span> <span class="hljs-string">&apos;16&apos;</span>
<span class="hljs-attr">      - name:</span> Install dependencies
<span class="hljs-attr">        run:</span> npm install
<span class="hljs-attr">      - name:</span> Build GitBook
<span class="hljs-attr">        run:</span> gitbook build
<span class="hljs-attr">      - name:</span> Deploy
<span class="hljs-attr">        run:</span> <span class="hljs-comment"># &#x90E8;&#x7F72;&#x5230;&#x60A8;&#x7684;&#x670D;&#x52A1;&#x5668;</span>
</code></pre>
<h2 id="&#x6545;&#x969C;&#x6392;&#x9664;">&#x6545;&#x969C;&#x6392;&#x9664;</h2>
<h3 id="&#x5E38;&#x89C1;&#x95EE;&#x9898;">&#x5E38;&#x89C1;&#x95EE;&#x9898;</h3>
<p><strong>Q: &#x6309;&#x94AE;&#x4E0D;&#x663E;&#x793A;&#xFF1F;</strong>
A: &#x68C0;&#x67E5; <code>repo</code> &#x914D;&#x7F6E;&#x662F;&#x5426;&#x6B63;&#x786E;&#xFF0C;&#x786E;&#x4FDD;&#x4ED3;&#x5E93;&#x8DEF;&#x5F84;&#x683C;&#x5F0F;&#x4E3A; <code>owner/name</code></p>
<p><strong>Q: &#x70B9;&#x51FB;&#x6309;&#x94AE;&#x65E0;&#x54CD;&#x5E94;&#xFF1F;</strong>
A: &#x68C0;&#x67E5;&#x7F51;&#x7EDC;&#x8FDE;&#x63A5;&#xFF0C;&#x67E5;&#x770B;&#x6D4F;&#x89C8;&#x5668;&#x63A7;&#x5236;&#x53F0;&#x662F;&#x5426;&#x6709;&#x9519;&#x8BEF;&#x4FE1;&#x606F;</p>
<p><strong>Q: &#x6837;&#x5F0F;&#x663E;&#x793A;&#x5F02;&#x5E38;&#xFF1F;</strong>
A: &#x68C0;&#x67E5;&#x662F;&#x5426;&#x6709; CSS &#x51B2;&#x7A81;&#xFF0C;&#x786E;&#x8BA4;&#x63D2;&#x4EF6;&#x6B63;&#x786E;&#x52A0;&#x8F7D;</p>
<h3 id="&#x8C03;&#x8BD5;&#x65B9;&#x6CD5;">&#x8C03;&#x8BD5;&#x65B9;&#x6CD5;</h3>
<ol>
<li>&#x6253;&#x5F00;&#x6D4F;&#x89C8;&#x5668;&#x5F00;&#x53D1;&#x8005;&#x5DE5;&#x5177;</li>
<li>&#x67E5;&#x770B;&#x63A7;&#x5236;&#x53F0;&#x9519;&#x8BEF;&#x4FE1;&#x606F;</li>
<li>&#x68C0;&#x67E5;&#x7F51;&#x7EDC;&#x8BF7;&#x6C42;&#x662F;&#x5426;&#x6210;&#x529F;</li>
<li>&#x9A8C;&#x8BC1;&#x914D;&#x7F6E;&#x662F;&#x5426;&#x6B63;&#x786E;</li>
</ol>
<h3 id="&#x83B7;&#x53D6;&#x5E2E;&#x52A9;">&#x83B7;&#x53D6;&#x5E2E;&#x52A9;</h3>
<ul>
<li>&#x67E5;&#x770B; <a href="../docs/API.md">API &#x6587;&#x6863;</a></li>
<li>&#x9605;&#x8BFB; <a href="../docs/DEVELOPMENT.md">&#x5F00;&#x53D1;&#x6307;&#x5357;</a></li>
<li>&#x63D0;&#x4EA4; <a href="https://gitcode.com/nutpi/gitbook-plugin-gitcode-issue-feedback/issues" target="_blank">Issue</a></li>
</ul>

                                
                                </section>
                            
    </div>
    <div class="search-results">
        <div class="has-results">
            
            <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
            <ul class="search-results-list"></ul>
            
        </div>
        <div class="no-results">
            
            <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
            
        </div>
    </div>
</div>

                        </div>
                    </div>
                
            </div>

            
                
                <a href="configuration.html" class="navigation navigation-prev " aria-label="Previous page: 配置选项">
                    <i class="fa fa-angle-left"></i>
                </a>
                
                
                <a href="faq.html" class="navigation navigation-next " aria-label="Next page: 常见问题">
                    <i class="fa fa-angle-right"></i>
                </a>
                
            
        
    </div>

    <script>
        var gitbook = gitbook || [];
        gitbook.push(function() {
            gitbook.page.hasChanged({"page":{"title":"使用示例","level":"1.4","depth":1,"next":{"title":"常见问题","level":"1.5","depth":1,"path":"faq.md","ref":"faq.md","articles":[]},"previous":{"title":"配置选项","level":"1.3","depth":1,"path":"configuration.md","ref":"configuration.md","articles":[]},"dir":"ltr"},"config":{"plugins":["gitcode-issue-feedback","livereload"],"styles":{"website":"styles/website.css"},"pluginsConfig":{"gitcode-issue-feedback":{"repo":"nutpi/gitbook-plugin-gitcode-issue-feedback","label":"报告问题","private":false},"livereload":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css","website":"styles/website.css"},"showLevel":false}},"theme":"default","author":"nutpi","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"GitCode Issue Feedback 演示","language":"zh-hans","gitbook":">=3.0.0","description":"一个展示 GitCode Issue Feedback 插件功能的演示项目"},"file":{"path":"examples.md","mtime":"2025-09-12T00:27:29.559Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2025-09-12T07:01:57.665Z"},"basePath":".","book":{"language":""}});
        });
    </script>
</div>

        
    <script src="gitbook/gitbook.js"></script>
    <script src="gitbook/theme.js"></script>
    
        
        <script src="gitbook/gitbook-plugin-gitcode-issue-feedback/plugin.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-livereload/plugin.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-search/search.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
        
    

    </body>
</html>

